/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package javax.enterprise.event;

import java.lang.annotation.*;
import javax.enterprise.util.TypeLiteral;

/**
 * Injectable interface providing simplified access to the event system.
 *
 * <code><pre>
 * class MyBean {
 *   @Any Event&lt;MyEvent> _myEvent;
 *
 *   void myMethod()
 *   {
 *     _myEvent.fire(new MyEvent("test"));
 *   }
 * }
 * </pre></code>
 */
public interface Event<T> {
  /**
   * Fires an event with the Event object's bindings.
   *
   * @param event the event to fire
   */
  public void fire(T event);

  /**
   * Adds the current set of qualifiers, returning a new Event object.
   *
   * @param qualifiers the additional qualifiers
   */
  public Event<T> select(Annotation... qualifiers);

  /**
   * Adds the current set of bindings, returning a new Event object.
   *
   * @param subtype the restricted type
   * @param qualifiers the additional qualifiers
   */
  public <U extends T> Event<U> select(Class<U> subtype,
                                       Annotation... qaualifiers);

  /**
   * Adds the current set of qualifiers, returning a new Event object.
   *
   * @param subtype the restricted type
   * @param qualifiers the additional qualifiers
   */
  public <U extends T> Event<U> select(TypeLiteral<U> subtype,
                                       Annotation... qualifiers);
}
